<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>WindowContext xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/com/totsp/gwittir/client/util/WindowContext.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * Created on August 3, 2007, 3:40 PM</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * This library is free software; you can redistribute it and/or</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> * modify it under the terms of the GNU Lesser General Public</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * License as published by the Free Software Foundation; either</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * version 2.1 of the License, or (at your option) any later version.</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> *</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> * This library is distributed in the hope that it will be useful,</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * Lesser General Public License for more details.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> *</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * You should have received a copy of the GNU Lesser General Public</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * License along with this library; if not, write to the Free Software</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA</em>
<a name="17" href="#17">17</a>  <em class="jxr_comment"> */</em>
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">package</strong> com.totsp.gwittir.client.util;
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.util.Set;
<a name="23" href="#23">23</a>  
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> com.google.gwt.core.client.GWT;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> com.google.gwt.user.client.Window;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> com.google.gwt.user.client.WindowCloseListener;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> com.totsp.gwittir.client.log.Level;
<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> com.totsp.gwittir.client.log.Logger;
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> com.totsp.gwittir.client.util.impl.WindowContextPersister;
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> com.totsp.gwittir.client.util.impl.WindowContextPersisterMacShell;
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment">/**</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * The WindowContext class is a front end for abstract client storage, allowing for the storage of</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * key/value pairs that persist on the client between browser sessions.</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * </em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * It is built on top of the other persistence systems in the client.util package and fails down (with</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * availablility from Gears to MSIE UserData, to FireFox/Opera DOMStorage (and in the future to Flash LSO).</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * </em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * @author &lt;a href="cooper@screaming-penguin.com"&gt;Robert "kebernet" Cooper&lt;/a&gt;</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> */</em>
<a name="41" href="#41">41</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/totsp/gwittir/client/util/WindowContext.html">WindowContext</a> {
<a name="42" href="#42">42</a>  
<a name="43" href="#43">43</a>  	<em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment">	 * The static instance of the WindowContext object.</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="46" href="#46">46</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../com/totsp/gwittir/client/util/WindowContext.html">WindowContext</a> INSTANCE = <strong class="jxr_keyword">new</strong> <a href="../../../../../com/totsp/gwittir/client/util/WindowContext.html">WindowContext</a>();
<a name="47" href="#47">47</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map&lt;String, String&gt; data = <strong class="jxr_keyword">new</strong> HashMap&lt;String, String&gt;();
<a name="48" href="#48">48</a>  	<strong class="jxr_keyword">private</strong> <a href="../../../../../com/totsp/gwittir/client/util/impl/WindowContextPersister.html">WindowContextPersister</a> persister = (WindowContextPersister) GWT
<a name="49" href="#49">49</a>  			.create(WindowContextPersister.<strong class="jxr_keyword">class</strong>);
<a name="50" href="#50">50</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> WindowCloseListener wcl = <strong class="jxr_keyword">new</strong> WindowCloseListener() {
<a name="51" href="#51">51</a>  		<strong class="jxr_keyword">public</strong> String onWindowClosing() {
<a name="52" href="#52">52</a>  			flush();
<a name="53" href="#53">53</a>  			<strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="54" href="#54">54</a>  		}
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>  		<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onWindowClosed() {
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>  		}
<a name="59" href="#59">59</a>  	};
<a name="60" href="#60">60</a>  
<a name="61" href="#61">61</a>  	<strong class="jxr_keyword">private</strong> <a href="../../../../../com/totsp/gwittir/client/util/WindowContext.html">WindowContext</a>() {
<a name="62" href="#62">62</a>  		<strong class="jxr_keyword">super</strong>();
<a name="63" href="#63">63</a>  		Window.addWindowCloseListener(wcl);
<a name="64" href="#64">64</a>  	}
<a name="65" href="#65">65</a>  
<a name="66" href="#66">66</a>  	<em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">	 * Immediately writes the values in the context to whatever the persistent store is. This</em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">	 * will happen automatically during onWindowClosing(); Final storage may or may not be synchronous</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">	 * to the call of the flush() method.</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="71" href="#71">71</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> flush() {
<a name="72" href="#72">72</a>  		persister.storeWindowContextData(data);
<a name="73" href="#73">73</a>  	}
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">	 * Initializes the WindowContext. Takes in a call back that will be notified when the</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">	 * initialization procedure is complete. This will *always* take place off the execution </em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">	 * context of the call to initialize, whether the individual persistence mechanism is asynchronous</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">	 * or not.</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">	 * Calls to initialize after the first will be ignored.</em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">	 * @param callback WindowContextCallback to notify when the WindowContext has been initialized. </em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="85" href="#85">85</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> initialize(<strong class="jxr_keyword">final</strong> <a href="../../../../../com/totsp/gwittir/client/util/WindowContext.html">WindowContextCallback</a> callback) {
<a name="86" href="#86">86</a>  		<strong class="jxr_keyword">if</strong>(!GWT.isScript() &amp;&amp; getUserAgent().indexOf(<span class="jxr_string">"WebKit"</span>) != -1){
<a name="87" href="#87">87</a>  			<strong class="jxr_keyword">this</strong>.persister = <strong class="jxr_keyword">new</strong> <a href="../../../../../com/totsp/gwittir/client/util/impl/WindowContextPersisterMacShell.html">WindowContextPersisterMacShell</a>();
<a name="88" href="#88">88</a>  			GWT.log(<span class="jxr_string">"WARNING: You are in hosted mode on Safari. Defaulting to the WindowName persister because HTML5 won't work in hosted mode!"</span>, <strong class="jxr_keyword">null</strong>);
<a name="89" href="#89">89</a>  		}
<a name="90" href="#90">90</a>  		Logger.getLogger(WindowContext.<strong class="jxr_keyword">class</strong>.toString()).log( Level.INFO, <span class="jxr_string">"Got persister :"</span>+persister.getClass(), <strong class="jxr_keyword">null</strong>);
<a name="91" href="#91">91</a>  		WindowContextCallback internalCallback = <strong class="jxr_keyword">new</strong> <a href="../../../../../com/totsp/gwittir/client/util/WindowContext.html">WindowContextCallback</a>() {
<a name="92" href="#92">92</a>  
<a name="93" href="#93">93</a>  			<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onInitialized() {
<a name="94" href="#94">94</a>  				data.putAll(persister.getWindowContextData());
<a name="95" href="#95">95</a>  				callback.onInitialized();
<a name="96" href="#96">96</a>  			}
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>  		};
<a name="99" href="#99">99</a>  		persister.init(internalCallback);
<a name="100" href="#100">100</a> 	}
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a> 	<em class="jxr_javadoccomment">/**</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">	 * Gets the value of a key</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">	 * @param key The key value to lookup</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">	 * @return a value or null</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">	 */</em>
<a name="107" href="#107">107</a> 	<strong class="jxr_keyword">public</strong> String get(String key) {
<a name="108" href="#108">108</a> 		<strong class="jxr_keyword">return</strong> data.get(key);
<a name="109" href="#109">109</a> 	}
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a> 	<em class="jxr_javadoccomment">/**</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">	 * Inserts a new value into the dataset</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">	 * @param key the key to insert. Keys should contain ONLY alphanumeric characters.</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">	 * @param item the new value to insert.</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">	 */</em>
<a name="116" href="#116">116</a> 	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> put(String key, String item) {
<a name="117" href="#117">117</a> 		assert key.matches(<span class="jxr_string">"[a-zA-Z0-9]*"</span>) : <span class="jxr_string">"Illegal character in the key"</span>;
<a name="118" href="#118">118</a> 		data.put(key, item);
<a name="119" href="#119">119</a> 	}
<a name="120" href="#120">120</a> 
<a name="121" href="#121">121</a> 	<strong class="jxr_keyword">public</strong> Set&lt;String&gt; keySet(){
<a name="122" href="#122">122</a> 		<strong class="jxr_keyword">return</strong> data.keySet();
<a name="123" href="#123">123</a> 	}
<a name="124" href="#124">124</a> 	
<a name="125" href="#125">125</a> 	<em class="jxr_javadoccomment">/**</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">	 * An interface to implement to receive notification of when the WindowContext has been initialized.</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">	 * </em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">	 */</em>
<a name="129" href="#129">129</a> 	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../com/totsp/gwittir/client/util/WindowContext.html">WindowContextCallback</a> {
<a name="130" href="#130">130</a> 
<a name="131" href="#131">131</a> 		<em class="jxr_javadoccomment">/**</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">		 * Called asynchronously when the WindowContext is ready for use.</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">		 */</em>
<a name="134" href="#134">134</a> 		<strong class="jxr_keyword">void</strong> onInitialized();
<a name="135" href="#135">135</a> 	}
<a name="136" href="#136">136</a> 	
<a name="137" href="#137">137</a> 	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">native</strong> String getUserAgent()
<a name="138" href="#138">138</a> 	<em class="jxr_comment">/*<em class="jxr_comment">-{return navigator.userAgent; }-*/</em>;</em>
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

